home *** CD-ROM | disk | FTP | other *** search
/ Magnum One / Magnum One (Mid-American Digital) (Disc Manufacturing).iso / d22 / wssi338b.arc / WSIMP332.DOC < prev    next >
Text File  |  1988-09-16  |  6KB  |  133 lines
  1.  
  2.  
  3.  
  4.          Copyright (C) 1988 by Robert W. Babcock and WSS Division of DDC
  5.                                All Rights Reserved
  6.  
  7.  
  8.           Instructions for WSSINDEX comment import routine version 3.32
  9.  
  10.         WSIMPORT is a utility for adding comments to an existing WSSINDEX 
  11.         database.   It  can be used to extract comments from such sources 
  12.         as a listing of files from  a bulletin board or the ascii  output 
  13.         from  another  disk  indexing  program.   It does  not  create  a 
  14.         database  from  scratch from an ascii input file,  so it  is  not 
  15.         quite what is normally called an import routine.
  16.  
  17.         Features:
  18.  
  19.              1. Filename  format may be either FILENAME.EXT  or  FILENAME  
  20.                 EXT (but not a mixture)
  21.              2. Filenames may be in mixed case
  22.              3. Tabs are expanded
  23.              4. Processing   speed  is  around  1000  lines  per  minute, 
  24.                 depending on the database size and your CPU speed
  25.  
  26.         Requirements on the input file:
  27.  
  28.              1. File names must appear before the comments
  29.              2. Nothing can appear after the comment
  30.              3. File names and comments must begin in fixed columns
  31.              4. Comments must be on the same line as the file name.
  32.              5. Lines must end with line feeds (if you can type the file, 
  33.                 it meets this requirement)
  34.  
  35.         Before starting the program, you should examine the comment file, 
  36.         either  by typing it or with a text editor,  to  determine  which 
  37.         columns  the  file  names (and extensions if the  format  is  not 
  38.         FILENAME.EXT) and comments begin in.  Number the columns starting 
  39.         with one,  not zero.   In general,  it is not necessary to remove 
  40.         headers or other extraneous lines from the input file;  they will 
  41.         simply  not  match  any files in the database and  will  thus  be 
  42.         ignored.  But if there are any control characters embedded in the 
  43.         comments  (such  as  might  be  introduced by  line  noise  in  a 
  44.         downloaded  file)  they should be removed or else  they  will  be 
  45.         interpreted  as  the  end of the comment.   You can be  a  little 
  46.         sloppy  with the starting column for comments since  the  program 
  47.         will remove any leading (or trailing) blanks.
  48.  
  49.         The executable module in the distribution package is WSIMPnnn.EXE 
  50.         (WSIMnnnR.EXE  for  Rainbow version),  where nnn is  the  version 
  51.         number.   You  might want to rename it  WSIMPORT.EXE.   When  the 
  52.         program  starts  up,  it  goes  through  the  same  configuration 
  53.         procedure as WSSINDEX,  although the only configurable parameters 
  54.         which  matter are the size limits on the database and whether  or 
  55.         not  to  create  BAK files.   The database is read  and  you  are 
  56.         prompted  for  the  name  of  the comment  file  and  the  format 
  57.         (FILENAME.EXT or FILENAME EXT and starting columns).  You will be 
  58.         given the option to override or keep previously existing comments 
  59.  
  60.  
  61.  
  62.  
  63.  
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.         in the database if a new comment is found.   You can also specify 
  71.         a category string which will be applied to every file which has a 
  72.         new comment assigned (unless you prohibit replacing comments  and 
  73.         the  file had a category but not a comment previously  assigned).  
  74.         At most points you can terminate the program by hitting escape.
  75.  
  76.         After  initializing,  the  database  is sorted by file  name  and 
  77.         extension.  You already know about how long this will take if you 
  78.         have  used any of the sorting options in WSSINDEX.   The  program 
  79.         remembers  the sequence number where each letter  first  appears, 
  80.         and starts searching for matching files there.  A fancier hashing 
  81.         algorithm  and  a  binary search could be used,  but  my  testing 
  82.         indicates  that  the sorting time will typically be  as  long  or 
  83.         longer than the processing time for reasonable sized input files, 
  84.         so not much can be gained here.
  85.  
  86.         The comment file is read line-by-line,  and lines which appear to 
  87.         contain  a filename and a comment are processed.   Note that  the 
  88.         same  comment may be applied to multiple database entries,  since 
  89.         disk and subdirectory names are not checked.
  90.  
  91.         When  the program finishes procesing the comment file,  it prints 
  92.         out a few statistics (number of input lines,  number of  comments 
  93.         applied,  etc.)   and gives you the option of making another pass 
  94.         with  a  different  comment file.   When you  finally  select  no 
  95.         further passes,  you specify the output file name and the updated 
  96.         database is saved.   As usual,  a previously existing database of 
  97.         the  same  name  will  be renamed with a  BAK  extension  (if  so 
  98.         configured)
  99.  
  100.         Your  comments  are invited on the usefulness  of,  and  possible 
  101.         enhancements to, this utility.  Use of this program is covered by 
  102.         the same shareware terms as WSSINDEX;  see the WSSINDEX DOC  file 
  103.         for more information.
  104.  
  105.         Robert W. Babcock
  106.         WSS Division of DDC
  107.         4 Reeves Road
  108.         Bedford, MA  01730
  109.         USA
  110.         617-275-1183
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.  
  130.  
  131.  
  132.  
  133.